<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。JCAT 由中国团队开发维护。
//  正在使用的这个版本是：0.5.0 / SVN信息: $Id: class.JCAT_FSPackage.php 1594 2009-03-31 11:29:38Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [下载(HTTP)] http://code.google.com/p/jcat-php/downloads/list
//    [下载(svn)] svn checkout http://jcat-php.googlecode.com/svn/branches/0.4.0/Framework/ JCAT0.4
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.com/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.com/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/
namespace JCAT ;

/**
 * 用于文件系统打包
 *
 */
class FSPackage
{
	
	/**
	 * what's this
	 * 
	 * @access	public
	 * @param	$sSourcePath		string		源路径
	 * @param	$sTargetPath					string		目标路径
	 * @param	$nCompressLevel=1				int			文件压缩级别
	 * @param	$Callback=null					null			进度回调函数
	 * @param	$arrCallbackArgvs=array()		array		调用回调函数时使用的参数
	 * @static
	 * @return	bool
	 */
	static public function Pack($sSourcePath,$sTargetPath,$nCompressLevel=1,$Callback=null,$arrCallbackArgvs=array())
	{
		ASSERT::ASSERT_PATH($sSourcePath) ;
		ASSERT::ASSERT_INT($nCompressLevel) ;
		ASSERT::ASSERT_( $nCompressLevel<=9&&$nCompressLevel>=0, Language::SentenceEx('参数 $nCompressLevel（%d）必须为 0-9','JCAT',null,$nCompressLevel)) ;
		
		
		// 如果 目标路径 给入的是一个目录
		if( is_dir($sTargetPath) )
		{
			$sTargetFile = $sTargetPath . basename($sSourcePath).'.pack' ;
		}
		else 
		{
			$sTargetFile = $sTargetPath ;
		}
		
		// 打开文件
		$aPackFile = new File($sTargetFile) ;
		if( !$aPackFile->Open('w') )
		{
			return false ;
		}
		
		// 整理文件路径
		$sTargetFile = GlobalFunc::TidyPath($sTargetFile) ;
		
		// 文件清单
		$arrFileList = array() ;
		
		// 开始 打包 ::::::::::::::::::::
		try 
		{
			// 压缩单一文件
			if( is_file($sSourcePath) )
			{
				$arrFileInfo = self::_PackOneFile($sSourcePath,$nCompressLevel) ;
				$arrFileInfo['path'] = basename($sSourcePath) ;
				$arrFileList[] = $arrFileInfo ;
			}
			
			// 压缩整个目录
			else
			{
				$aIterator = new FSOTreeIterator($sSourcePath,FSOIterator::DEFAULT_FLAG|FSOIterator::RETURN_DIR) ;
				$aIterator->First() ;
				while( !$aIterator->IsDone() )
				{
					$sPath = $aIterator->Current() ;
					
					// 压缩文件
					if( is_file($sPath) )
					{
						$arrFileInfo = self::_PackOneFile($sPath,$nCompressLevel) ;
						
						if( $Callback )
						{
							$arrArgvs = array_merge(array($sPath),$arrCallbackArgvs) ;
							call_user_func_array($Callback,$arrArgvs) ;
						}
					}
					
					// 子目录
					else 
					{
						$arrFileInfo = array(
							'type' => 'dir'							
						) ;
					}
					
					// 设置 包内路径
					$arrFileInfo['path'] = Directory::GetRelativePath($sSourcePath,$sPath) ;
					$arrFileList[] = $arrFileInfo ;
				
					// 下一个
					$aIterator->Next() ;
				}
			}
		}
		
		// 异常
		catch (Exception $aException)
		{
			print $aException->getMessage() ;
			$aPackFile->Close() ;
			unlink($aPackFile->GetPath()) ;
			
			return false ;
		}

		
		// 写入文件头和文件清单 :::::::::::;
		
		
		// 创建文件清单xml
		$sFileListXML = "<FileList>\r\n" ;
		$sTotalByteLength = 0 ;
		foreach ($arrFileList as $arrItem)
		{
			if( $arrItem['type']=='file' )
			{
				$sFileListXML.= "	<File" ;
				$sFileListXML.= " md5=\"{$arrItem['md5']}\"";
				$sFileListXML.= ' compress_bytes="'. strlen($arrItem['compress_bytes']) .'"';
				$sFileListXML.= ">{$arrItem['path']}</File>\r\n" ;
				
				$sTotalByteLength+= $arrItem['compress_bytes'] ;
			}
			
			else 
			{
				$sFileListXML.= "	<Directory>{$arrItem['path']}</Directory>\r\n" ;
			}
		}
		$sFileListXML.= "</FileList>" ;
		
		// 压缩 文件清单
		$sFileListXMLCompressed = gzcompress($sFileListXML,$nCompressLevel) ;
		$nFileListLen = strlen($sFileListXMLCompressed) ;
		
		
		// 整理文件头 ::::::::::::::::::::::::
		
		// 开头记号
		$sHeader = pack("ccLA{$nFileListLen}"
						, 0, 8
						, $nFileListLen						// 文件清单長度
						, $sFileListXMLCompressed) ;		// 文件清单
		
		// 将 header 写入到文件开头
		$aPackFile->Write($sHeader) ;
		
		
		// 写入各文件的内容
		foreach ($arrFileList as $arrItem)
		{
			if( $arrItem['type']=='file' )
			{
				$aPackFile->Write($arrItem['compress_bytes']) ;
			}
		}
		
		
		// 关闭文件 并返回
		$aPackFile->Close() ;
		
		return true ;
	}

	
	/**
	 * what's this
	 * 
	 * @access	public
	 * @param	$sSourcePath					string		源路径
	 * @param	$sTargetPath					string		目标路径
	 * @param	$Callback=null					null			进度回调函数
	 * @param	$arrCallbackArgvs=array()		array		调用回调函数时使用的参数
	 * @static
	 * @return	bool
	 */
	static public function Unpack($sPackagePath,$sTargetDir,$Callback=null,$arrCallbackArgvs=array())
	{
		ASSERT::ASSERT_FILE($sPackagePath);
		ASSERT::ASSERT_DIR($sTargetDir);
		
		$hFile = fopen($sPackagePath,'r') ;
		if(!$hFile)
		{
			return false ;
		}
		
		$bRet = self::UnpackFromHandle($hFile,$sTargetDir,$Callback,$arrCallbackArgvs) ;
		
		fclose($hFile) ;

		return $bRet ;
	}
	
	/**
	 * what's this
	 * 
	 * @access	public
	 * @param	$hFileHand						string		已打开文件操作句柄
	 * @param	$sTargetPath					string		目标路径
	 * @param	$Callback=null					null			进度回调函数
	 * @param	$arrCallbackArgvs=array()		array		调用回调函数时使用的参数
	 * @static
	 * @return	bool
	 */
	static public function UnpackFromHandle($hFileHand,$sTargetDir,$Callback=null,$arrCallbackArgvs=array())
	{
		// 取得文件长度
		fseek($hFileHand,0,SEEK_END) ;
		$nFileTotalSize = ftell($hFileHand) ;
		
		// 回到文件开头
		rewind($hFileHand) ;
		
		// 2+4? 2个字节为 开始标记，4个字节为 文件清单的長度
		$sHeader = fread($hFileHand,2+4) ;
		$sTargetDir = GlobalFunc::TidyPath($sTargetDir) ;
		
		// 读取 Header 信息
		$arrHeaderInfos = unpack('cMark1/cMark2/LFileListLen',$sHeader) ;
		
		// 检查开始标记, 开始字节 为 字符“0”+“8”
		if( !$arrHeaderInfos or $arrHeaderInfos['Mark1']!==0 or $arrHeaderInfos['Mark2']!==8 )
		{
			return false ;
		}
		
		// 文件内容 总长
		$nContentSize = $nFileTotalSize - $arrHeaderInfos['FileListLen'] - 6 ;

		// 读取文件清单
		$sFileListXMLSrc = fread($hFileHand, $arrHeaderInfos['FileListLen'] ) ;

		// 恢复 文件清单
		$sFileListXML = gzuncompress($sFileListXMLSrc) ;
		$aFileListXML = new SimpleXMLElement($sFileListXML) ;
		
		// 创建目录
		foreach ($aFileListXML->Directory as $sDirectory)
		{
			$sPath = $sTargetDir.$sDirectory ;
			mkdir($sPath,0755,true) ;
			
			if( !is_dir($sPath) )
			{
				return false ;
			}

			// 进度回调函数
			if( $Callback )
			{
				$arrArgvs = array_merge(array(
								Language::SentenceEx('创建目录: %s','JCAT',null,$sPath)			// 参数1：包内路径
								, 0																		// 参数2：文件压缩长度
								, 0																		// 参数3：总压缩字节数
								, 0																		// 参数4：已解压字节数
				),$arrCallbackArgvs) ;
				call_user_func_array($Callback,$arrArgvs) ;
			}
		}
		
		// 创建文件
		$nCompleted = 0 ;
		foreach ($aFileListXML->File as $aXMLNodeFile)
		{
			$sPath = $sTargetDir.$aXMLNodeFile ;
			
			// 读取文件
			$nLeave = $nCompressBytes = intval($aXMLNodeFile['compress_bytes']) ;
			$sFileSrc = '' ;
			while( $nLeave>0 and !feof($hFileHand) ) 
			{
				$nThisTime = ( $nLeave > 8192)?
								8192: $nLeave ;
				$nLeave-= $nThisTime ;
				$sFileSrc.= fread($hFileHand,$nThisTime) ;
			}
			
			// 释放文件
			$sFile = gzuncompress($sFileSrc) ;
			if( $sFile===false )
			{
				return false ;
			}
			
			// 写入到硬盘
			file_put_contents($sPath,$sFile) ;
			
			$nCompleted+= $nCompressBytes ;
		
			// 进度回调函数
			if( $Callback )
			{
				$arrArgvs = array_merge(array(
								Language::SentenceEx('释放文件: %s','JCAT',null,$aXMLNodeFile)				// 参数1：包内路径
								, $nCompressBytes																// 参数2：文件压缩长度
								, $nContentSize																	// 参数3：总压缩字节数
								, $nCompleted																	// 参数4：已解压字节数
				),$arrCallbackArgvs) ;
				call_user_func_array($Callback,$arrArgvs) ;
			}
		}
		
		return true ;
	}
	
	
	
	
	/**
	 * what's this
	 * 
	 * @access	private
	 * @return	array, false
	 */
	static private function _PackOneFile($sFilePath,$nCompressLevel)
	{
		ASSERT::ASSERT_FILE($sFilePath) ;
		
		// 读取文件
		$sContent = file_get_contents($sFilePath) ;
		if( $sContent===false )
		{
			throw new Exception() ;
		}
		
		// 压缩文件内容
		$sCompressed = gzcompress($sContent,$nCompressLevel) ;
		
		$arrFileInfo = array(
			'type' => 'file' ,
			'md5' => md5_file($sFilePath) ,
			'compress_bytes' => $sCompressed ,
		) ;
		
		// 返回
		return $arrFileInfo ;
	}
	
	
	
}

?>